<!--$Id: auto.so,v 10.6 2008/01/19 14:12:58 bostic Exp $-->
<!--Copyright (c) 1997,2008 Oracle.  All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB Reference Guide: Automatically generated functions</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td><b><dl><dt>Berkeley DB Reference Guide:<dd>Application Specific Logging and Recovery</dl></b></td>
<td align=right><a href="../apprec/def.html"><img src="../../images/prev.gif" alt="Prev"></a><a href="../toc.html"><img src="../../images/ref.gif" alt="Ref"></a><a href="../apprec/config.html"><img src="../../images/next.gif" alt="Next"></a>
</td></tr></table>
<p align=center><b>Automatically generated functions</b></p>
<p>The XXX.src file is processed using the gen_rec.awk script included in
the dist directory of the Berkeley DB distribution.  This is an awk script
that is executed from with the following command line:</p>
<blockquote><pre>awk -f gen_rec.awk \
	-v source_file=<i>C_FILE</i> \
	-v header_file=<i>H_FILE</i> \
	-v print_file=<i>P_FILE</i> \
	-v template_file=<i>TMP_FILE</i> &lt; XXX.src</pre></blockquote>
<p>where <i>C_FILE</i> is the name of the file into which to place the
automatically generated C code, <i>H_FILE</i> is the name of the
file into which to place the automatically generated data structures
and declarations, <i>P_FILE</i> is the name of the file into which to
place the automatically generated C code that prints log records,
and <i>TMP_FILE</i> is the name of the file into
which to place a template for the recovery routines.</p>
<p>Because the gen_rec.awk script uses sources files located relative to
the Berkeley DB dist directory, it must be run from the dist directory.  For
example, in building the Berkeley DB logging and recovery routines for
ex_apprec, the following script is used to rebuild the automatically
generated files:</p>
<blockquote><pre>E=../examples_c/ex_apprec
<p>
cd ../../dist
awk -f gen_rec.awk \
    -v source_file=$E/ex_apprec_auto.c \
    -v header_file=$E/ex_apprec_auto.h \
    -v print_file=$E/ex_apprec_autop.c \
    -v template_file=$E/ex_apprec_template &lt; $E/ex_apprec.src</pre></blockquote>
<p>For each log record description found in the XXX.src file, the following
structure declarations and #defines will be created in the file
<i>header_file</i>:</p>
<blockquote><pre>#define DB_PREFIX_RECORD_TYPE        /* Integer ID number */
<p>
typedef struct _PREFIX_RECORD_TYPE_args {
    /*
     * These three fields are generated for every record.
     */
    u_int32_t type;      /* Record type used for dispatch. */
<p>
    /*
     * Transaction handle that identifies the transaction on whose
     * behalf the record is being logged.
     */
    DB_TXN *txnid;
<p>
    /*
     * The log sequence number returned by the previous call to log_put
     * for this transaction.
     */
    DB_LSN *prev_lsn;
<p>
    /*
     * The rest of the structure contains one field for each of
     * the entries in the record statement.
     */
};</pre></blockquote>
<p>Thus, the auto-generated ex_apprec_mkdir_args structure looks as follows:</p>
<blockquote><pre>typedef struct _ex_apprec_mkdir_args {
	u_int32_t type;
	DB_TXN *txnid;
	DB_LSN prev_lsn;
	DBT	dirname;
} ex_apprec_mkdir_args;</pre></blockquote>
<p>The template_file will contain a template for a recovery function.  The
recovery function is called on each record read from the log during
system recovery, transaction abort, or the application of log records
on a replication client, and is expected to redo or undo the operations
described by that record.  The details of the recovery function will be
specific to the record being logged and need to be written manually, but
the template provides a good starting point.  (See ex_apprec_template
and ex_apprec_rec.c for an example of both the template produced and the
resulting recovery function.)</p>
<p>The template file should be copied to a source file in the application
(but not the automatically generated source_file, as that will get
overwritten each time gen_rec.awk is run) and fully developed there.
The recovery function takes the following parameters:</p>
<blockquote><br>
<b>dbenv</b><ul compact><li>The environment in which recovery is running.</ul>
<b>rec</b><ul compact><li>The record being recovered.</ul>
<b>lsn</b><ul compact><li>The log sequence number of the record being recovered.  The
prev_lsn field, automatically included in every auto-generated log
record, should be returned through this argument.  The prev_lsn field
is used to chain log records together to allow transaction aborts;
because the recovery function is the only place that a log record gets
parsed, the responsibility for returning this value lies with the
recovery function writer.</ul>
<b>op</b><ul compact><li>A parameter of type db_recops, which indicates what operation is being
run (<a href="../../api_c/env_set_app_dispatch.html#DB_TXN_ABORT">DB_TXN_ABORT</a>, <a href="../../api_c/env_set_app_dispatch.html#DB_TXN_APPLY">DB_TXN_APPLY</a>, <a href="../../api_c/env_set_app_dispatch.html#DB_TXN_BACKWARD_ROLL">DB_TXN_BACKWARD_ROLL</a>,
<a href="../../api_c/env_set_app_dispatch.html#DB_TXN_FORWARD_ROLL">DB_TXN_FORWARD_ROLL</a> or <a href="../../api_c/env_set_app_dispatch.html#DB_TXN_PRINT">DB_TXN_PRINT</a>).</ul>
<br></blockquote>
<p>In addition to the header_file and template_file, a source_file is
created, containing a log, read, recovery, and print function for each
record type.</p>
<p>The log function marshalls the parameters into a buffer, and calls
<a href="../../api_c/log_put.html">DB_ENV-&gt;log_put</a> on that buffer returning 0 on success and non-zero on
failure.  The log function takes the following parameters:</p>
<blockquote><br>
<b>dbenv</b><ul compact><li>The environment in which recovery is running.</ul>
<b>txnid</b><ul compact><li>The transaction identifier for the transaction handle returned by
<a href="../../api_c/txn_begin.html">DB_ENV-&gt;txn_begin</a>.</ul>
<b>lsnp</b><ul compact><li>A pointer to storage for a log sequence number into which the log
sequence number of the new log record will be returned.</ul>
<b>syncflag</b><ul compact><li>A flag indicating whether the record must be written synchronously.
Valid values are 0 and <a href="../../api_c/log_put.html#DB_FLUSH">DB_FLUSH</a>.</ul>
<b>args</b><ul compact><li>The remaining parameters to the log message are the fields described
in the XXX.src file, in order.</ul>
<br></blockquote>
<p>The read function takes a buffer and unmarshalls its contents into a
structure of the appropriate type.  It returns 0 on success and non-zero
on error.  After the fields of the structure have been used, the pointer
returned from the read function should be freed.  The read function
takes the following parameters:</p>
<blockquote><br>
<b>dbenv</b><ul compact><li>The environment in which recovery is running.</ul>
<b>recbuf</b><ul compact><li>A buffer.</ul>
<b>argp</b><ul compact><li>A pointer to a structure of the appropriate type.</ul>
<br></blockquote>
<p>The print function displays the contents of the record.  The print
function takes the same parameters as the recovery function described
previously.  Although some of the parameters are unused by the print
function, taking the same parameters  allows a single dispatch loop to
dispatch to a variety of functions.  The print function takes the
following parameters:</p>
<blockquote><br>
<b>dbenv</b><ul compact><li>The environment in which recovery is running.</ul>
<b>rec</b><ul compact><li>The record being recovered.</ul>
<b>lsn</b><ul compact><li>The log sequence number of the record being recovered.</ul>
<b>op</b><ul compact><li>Unused.</ul>
<br></blockquote>
<p>Finally, the source file will contain a function (named XXX_init_print,
where XXX is replaced by the prefix) which should be added to the
initialization part of the standalone <a href="../../utility/db_printlog.html">db_printlog</a> utility code
so that utility can be used to display application-specific log records.</p>
<table width="100%"><tr><td><br></td><td align=right><a href="../apprec/def.html"><img src="../../images/prev.gif" alt="Prev"></a><a href="../toc.html"><img src="../../images/ref.gif" alt="Ref"></a><a href="../apprec/config.html"><img src="../../images/next.gif" alt="Next"></a>
</td></tr></table>
<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
</body>
</html>
